home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / wc3x / giftxt10.zip / GIFTXT.DOC < prev    next >
Text File  |  1992-09-12  |  9KB  |  227 lines
  1.  
  2.  
  3.                     GIFTxt version 1.0 User Documentation
  4.  
  5.                       (c) Copyright 1992 by Tim Kilgore
  6.                              ALL RIGHTS RESERVED
  7.                 Protected Under Missouri General Copyright Laws
  8.  
  9.                              <  FREEWARE  >
  10.  
  11. What it Be -
  12.  
  13.    GIFTxt is, as far as I am aware, a first in BBSing.  GIFTxt scans
  14.    GIF files for internal comments and exports these comments to a
  15.    text file or directly into MSI's WILDCAT file database.
  16.  
  17. Disclaimer <sigh> -
  18.  
  19.    YOU USE GIFTXT.EXE AT YOUR OWN RISK.  THE AUTHOR WILL NOT BE HELD
  20.    RESPONSIBLE FOR DAMAGES, INTENTIONAL, UNINTENTIONAL, OR OTHERWISE.
  21.    YOUR USE OF GIFTXT.EXE INDICATES YOUR AGREEMENT WITH THESE TERMS.
  22.  
  23. Using GIFTxt -
  24.  
  25.    Typing GIFTxt and pressing enter will summon a help screen.  This
  26.    screen details the four modes of operation.  If you are in hurry,
  27.    try this now.
  28.  
  29.    GIFTxt has 4 operational modes, 3 of which are WILDCAT! specific
  30.    and require WILDCAT! system files to be present before the mode
  31.    will function correctly.
  32.  
  33.    Here is the calling syntax for each of the four modes:
  34.  
  35.       * GIFTXT all                      Scans ALL WC! file areas
  36.       * GIFTXT drv:\path\filename.GIF   SCANFILE.BAT mode for WC!
  37.       * GIFTXT a=nn                     Scans a single WC! file area
  38.         GIFTXT CDROM                    Dumps output to a text file
  39.                                         for later processing.
  40.  
  41.      * (WC! mode, must be executed from the main WC subdirectory.)
  42.  
  43.  
  44. The ALL mode -
  45.  
  46.    Calling syntax:  GIFTXT all
  47.  
  48.    GIFTxt will cycle through all WC file areas and secondary file
  49.    areas scanning for matching *.GIF files.  When it locates a file,
  50.    it scans the file for a comment.
  51.  
  52.    Once a complete area is scanned, GIFTxt will summon MSI's WCFILE.EXE
  53.    if comments have been found.  WCFILE will perform the actual job of
  54.    inserting the comments.  GIFTxt will then proceed to the next file
  55.    area until all file areas have been processed.
  56.  
  57.    This mode will make use of the WCNODEID environment variable.  It
  58.    is not required, though.  File sharing is active.
  59.  
  60.  
  61. The SCANFILE mode -
  62.  
  63.    Calling syntax:  GIFTXT drv:\path\filename.GIF
  64.  
  65.    GIFTxt extracts the drive and path information from the command-
  66.    line and compares this to the information contained in FILEAREA.DAT.
  67.    If a match is made, GIFTxt will scan the GIF for a comment and
  68.    summon WCFILE to insert the comment.
  69.  
  70.    This mode makes use of the WCNODEID environment variable if it is
  71.    available.  File sharing is active.
  72.  
  73.    To use GIFTXT as a part of your SCANFILE.BAT, add the following
  74.    lines to SCANFILE.BAT
  75.  
  76.                                 CD\WC30
  77.                                 GIFTXT %1
  78.  
  79.  
  80. The FILEAREA mode -
  81.  
  82.    Calling syntax:  GIFTXT a=nnn   (where nnn is replaced by digits)
  83.  
  84.    GIFTxt will scan FILEAREA.DAT and extracts record number nnn.  This
  85.    record contains all path information for a corresponding file area.
  86.  
  87.    GIFTxt will use the path information to scan all subdirectories
  88.    attached to a give file area.  If GIF's are found, GIFTxt scans
  89.    the GIF file for comments and (if necessary) summons WCFILE to
  90.    insert the comments into the WC file database.
  91.  
  92.    This mode make use of the WCNODEID environment variable if it is
  93.    available.  File sharing is active.
  94.  
  95.  
  96. The CDROM mode -
  97.  
  98.    Calling syntax:  GIFTXT CDROM
  99.  
  100.    This is the only mode than does not use WILDCAT! system files and
  101.    and may be used from any subdirectory as a result.
  102.  
  103.    GIFTxt will scan the current subdirectory for *.GIF files that
  104.    contain comments.  If one or more are found, you'll be prompted for
  105.    an path/filename to use for an output file.
  106.  
  107.    The output file uses the following format:
  108.  
  109.    [   1-12   ]   [   15 - ?? -------------------------------------->
  110.    FILENAME.EXT   resxres COMMENT LINE 1.............................
  111.                   COMMENT LINE 2.....................................
  112.                   etc, etc...........................................
  113.  
  114.    The output is suitable for use with MSI's WCFILE.EXE and will be
  115.    useful to any WILDCAT sysop with a CD-ROM.  This mode may also allow
  116.    other BBS systems to utilize GIFTxt.
  117.  
  118.    This mode is also useful if you are uncertain if you want to use
  119.    GIF comments as file descriptions.  It can be used safely to create
  120.    a preview.
  121.  
  122.    NOTE:  GIFTxt does NOT format the text in any way.  Lines can easily
  123.           exceed 80 columns.
  124.  
  125.  
  126. Comment Manipulation -
  127.  
  128.    GIFTxt does NOT send all lines of a description to output files or
  129.    to WildCat!.  GIFTxt intentionally strips copyright information
  130.    and distribution notices.  The end viewer can read these things
  131.    once he downloads the file.
  132.  
  133.    GIFTxt also strips "FILENAME:" and "TITLE:" lines since this gets
  134.    redundant and boring.  GIFTxt also strips blank lines since they
  135.    are not needed (or even used) by WildCat!.
  136.  
  137.    GIFTxt adds the resolution of the GIF to the first line of the file
  138.    description.  Note that the color palette information is NOT added.
  139.    (GIFTxt will add "640x480" for a 640x480x256 GIF file.)
  140.  
  141.  
  142. Operational Limitations and Notes -
  143.  
  144.    Speed was a major concern during the design of GIFTxt.  I made several
  145.    very small concessions to functionality to improve performance.
  146.  
  147.    First, GIFTxt will scan only files that are 4000+ bytes in size.
  148.    Smaller GIF's are ignored.
  149.  
  150.    Second, GIF's that have comments greater than 3500 bytes will be
  151.    skipped.  GIFTxt starts looking for a comment at FILE_SIZE - 3500.
  152.    This means that GIFTxt doesn't have to read the entire file looking
  153.    for a comment that would be too long to be included as a BBS
  154.    description anyhow.
  155.  
  156.    GIFTxt uses file locking/sharing as needed making it safe for use
  157.    in multinode environments.  No WC! system files are EVER opened in
  158.    a WRITE or READ/WRITE mode.
  159.  
  160.  
  161. Real-world Limitations -
  162.  
  163.    You'll soon discover that _very_ few GIF's have comments.  GIF's
  164.    originating on CIS tend to have nice descriptions added to them,
  165.    but very few other sources make use of GIF comments.
  166.  
  167.    I think that a good explaination for this is that nothing has
  168.    every really made use of GIF comments except after the GIF is
  169.    downloaded and is already in the hands of an individual.  By then it
  170.    really doesn't matter too much.  GIFTxt might help to change that
  171.    since a long description should help to 'sell' the GIF to the
  172.    intended audience.
  173.  
  174.  
  175. Creation Tools used -
  176.  
  177.    GIFTxt was written in 100% MicroSoft PDS BASIC 7.1 (aka QBX).  No
  178.    external libs or routines were used.  This means that if it's broke,
  179.    it can and will be fixed.
  180.  
  181.  
  182. About the Author -
  183.  
  184.    He smokes too much, drinks too little, but is an otherwise decent
  185.    joe that usually writes a program because he wants it _just_ so.
  186.  
  187.  
  188. In Closing -
  189.  
  190.    GIFTxt was an accident.  I didn't plan on writing it, but I stumbled
  191.    across a GIF that had a desciption and got curious.  My BBS, the ><,
  192.    has thousands of GIF's, so rather than use a viewer to sloooowly
  193.    find GIF's with comments, I wrote a little tool just to locate them.
  194.  
  195.    Well, the tool was ok, but it would have been nicer to see the comment
  196.    without shelling to another program.  So I added a display and dumping
  197.    it to a file was just a little more work.  Anyhow, things continued to
  198.    escalate and GIFTxt just sorta happened.
  199.  
  200.    If GIFTxt doesn't work, needs a new feature, or something else has
  201.    rattled your can and ya gotta talk about it, you can contact the author
  202.    at -
  203.  
  204.  
  205.                                 Planet ><
  206.                                  1:289/5
  207.                             314.443.0319 HST/DS
  208.  
  209.    If you are an author and are using GIFTxt, SDIZ, SDIZ2, or any other
  210.    FREEWARE util that I've written, you might think about sending me a
  211.    registered copy of whatever fabtabulous program(s) you've written.
  212.    It'd be a nice way of saying thanks and would probably earn you a
  213.    gratis registration of one of my mega-wunnferful pay-to-play programs.
  214.    Trading is inexpensive and fun...
  215.  
  216. One More Thing -
  217.  
  218.    I need beta testers.  Bad!  GIFTxt had _no_ testing because I can't
  219.    find a soul to beta test.
  220.  
  221.    If you've got a v.32 or HST modem, a netmailer, and want to beta test
  222.    utils and doors (games, mostly), then talk to me.  Please.
  223.  
  224.    Send netmail to 1:289/5 and include a voice number and a convienant
  225.    time range (6pm-10pm, whatever) for me to call you.
  226.  
  227.